home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1994 November: Tool Chest / Dev.CD Nov 94.toast / Tool Chest / Development Tools & Languages / Macintosh Common Lisp Related / interfaces / Components.lisp < prev    next >
Encoding:
Text File  |  1994-09-13  |  12.7 KB  |  327 lines  |  [TEXT/CCL2]
  1.  
  2. (in-package :TRAPS)             ; ************************************************************
  3. ;     Created: Wednesday, April 21, 1993
  4. ;     Modified:    Wed, Dec 1, 1993 16:39:45
  5. ; 
  6. ;     Components.p
  7. ;     Pascal Interface to the Macintosh Libraries
  8. ;     
  9. ;     Copyright Apple Computer, Inc. 1990-93
  10. ;     All rights reserved
  11. ; ************************************************************
  12.  
  13. ; $IFC UNDEFINED UsingIncludes
  14. ; $SETC UsingIncludes := 0
  15. ; $ENDC
  16.  
  17. ; $IFC NOT UsingIncludes
  18.  
  19. ; $ENDC
  20.  
  21. ; $IFC UNDEFINED UsingComponents
  22. ; $SETC UsingComponents := 1
  23.  
  24. ; $I+
  25. ; $SETC ComponentsIncludes := UsingIncludes
  26. ; $SETC UsingIncludes := 1
  27. ; $IFC UNDEFINED UsingTypes
  28.  
  29. (require-interface 'TYPES)      ; $I $$Shell(PInterfaces)Types.p
  30. ; $ENDC
  31. ; $IFC UNDEFINED UsingTypes
  32.  
  33. (require-interface 'MEMORY)     ; $I $$Shell(PInterfaces)Memory.p
  34. ; $ENDC
  35. ; $SETC UsingIncludes := ComponentsIncludes
  36.  
  37. ; $IFC UNDEFINED gestaltComponentMgrDeclared
  38. ; $SETC gestaltComponentMgrDeclared := True
  39. (defconstant $gestaltComponentMgr :|cpnt|)
  40. ; $ENDC
  41.  
  42. (defconstant $kAnyComponentType 0)
  43. (defconstant $kAnyComponentSubType 0)
  44. (defconstant $kAnyComponentManufacturer 0)
  45. (defconstant $kAnyComponentFlagsMask 0)
  46.  
  47. (defconstant $cmpWantsRegisterMessage #X80000000)
  48.  
  49. ;  Component Resource Extension flags 
  50. (defconstant $componentDoAutoVersion 1)
  51. (defconstant $componentWantsUnregister 2)
  52. (defconstant $componentAutoVersionIncludeFlags 4)
  53.  
  54. (defrecord ComponentDescription 
  55.    (componentType :OSTYPE)      ;  A unique 4-byte code indentifying the command set 
  56.    (componentSubType :OSTYPE)   ;  Particular flavor of this instance 
  57.    (componentManufacturer :OSTYPE);  Vendor indentification 
  58.    (componentFlags :SIGNED-LONG);  8 each for Component,Type,SubType,Manuf/revision 
  59.    (componentFlagsMask :SIGNED-LONG);  Mask for specifying which flags to consider in search, zero during registration 
  60.    )
  61.  
  62. (defrecord ResourceSpec 
  63.    (resType :OSTYPE)            ;  4-byte code  
  64.    (resId :SIGNED-INTEGER)      ;     
  65.    )
  66.  
  67. (def-mactype :COMPONENTRESOURCEPTR (find-mactype :POINTER))
  68. (def-mactype :COMPONENTRESOURCEHANDLE (find-mactype :HANDLE))
  69. (defrecord (ComponentResource :handle) 
  70.    (cd :COMPONENTDESCRIPTION)   ;  Registration parameters 
  71.    (component :RESOURCESPEC)    ;  resource where Component code is found 
  72.    (componentName :RESOURCESPEC);  name string resource 
  73.    (componentInfo :RESOURCESPEC);  info string resource 
  74.    (componentIcon :RESOURCESPEC);  icon resource 
  75.    )
  76.  
  77. (defrecord ComponentResourceExtension 
  78.    (componentVersion :SIGNED-LONG);  version of Component 
  79.    (componentRegisterFlags :SIGNED-LONG);  flags for registration 
  80.    (componentIconSuite :SIGNED-INTEGER);  resource id of Icon Suite 
  81.    )
  82.  
  83. (def-mactype :COMPONENTPTR (find-mactype :HANDLE))
  84. (def-mactype :COMPONENT (find-mactype :POINTER))
  85. (defrecord (ComponentRecord :handle) 
  86.    (data (:ARRAY :SIGNED-LONG 1))
  87.    )
  88.  
  89. (def-mactype :COMPONENTINSTANCE (find-mactype :POINTER))
  90. (defrecord ComponentInstanceRecord 
  91.    (data (:ARRAY :SIGNED-LONG 1))
  92.    )
  93.  
  94. ;  Structure received by Component:  
  95. (defrecord ComponentParameters 
  96.    (flags :CHARACTER)           ;  call modifiers: sync/async, deferred, immed, etc 
  97.    (paramSize :CHARACTER)       ;  size in bytes of actual parameters passed to this call 
  98.    (what :SIGNED-INTEGER)       ;  routine selector, negative for Component management calls 
  99.    (params (:ARRAY :SIGNED-LONG 1));  actual parameters for the indicated routine 
  100.    )
  101.  
  102. (def-mactype :COMPONENTRESULT (find-mactype :SIGNED-LONG))
  103.  
  104. (def-mactype :COMPONENTROUTINE (find-mactype :POINTER))
  105.  
  106. (def-mactype :COMPONENTFUNCTION (find-mactype :POINTER))
  107.  
  108. ; ******************************************************
  109. ; * Required Component routines
  110. ; ******************************************************
  111.  
  112. (defconstant $kComponentOpenSelect -1);  ComponentInstance for this open 
  113. (defconstant $kComponentCloseSelect -2);  ComponentInstance for this close 
  114. (defconstant $kComponentCanDoSelect -3);  selector # being queried 
  115. (defconstant $kComponentVersionSelect -4);  no params 
  116. (defconstant $kComponentRegisterSelect -5);  no params 
  117. (defconstant $kComponentTargetSelect -6);  ComponentInstance for top of call chain 
  118. (defconstant $kComponentUnregisterSelect -7);  no params 
  119.  
  120. ;  Set Default Component flags 
  121. (defconstant $defaultComponentIdentical 0)
  122. (defconstant $defaultComponentAnyFlags 1)
  123. (defconstant $defaultComponentAnyManufacturer 2)
  124. (defconstant $defaultComponentAnySubType 4)
  125. (defconstant $defaultComponentAnyFlagsAnyManufacturer (+ #$DEFAULTCOMPONENTANYFLAGS #$DEFAULTCOMPONENTANYMANUFACTURER))
  126. (defconstant $defaultComponentAnyFlagsAnyManufacturerAnySubType (+ #$DEFAULTCOMPONENTANYFLAGS (+ #$DEFAULTCOMPONENTANYMANUFACTURER #$DEFAULTCOMPONENTANYSUBTYPE)))
  127.  
  128. ;  errors from component manager & components 
  129. (defconstant $invalidComponentID -3000)
  130. (defconstant $validInstancesExist -3001)
  131. (defconstant $componentNotCaptured -3002)
  132. (defconstant $componentDontRegister -3003)
  133.  
  134. (defconstant $badComponentInstance #X80008001)
  135. (defconstant $badComponentSelector #X80008002)
  136.  
  137. ;  *******************************************************
  138. ; *                                                     *
  139. ; *              APPLICATION LEVEL CALLS                *
  140. ; *                                                     *
  141. ; *******************************************************
  142. ; * Component Database Add, Delete, and Query Routines 
  143. ; *******************************************************
  144. ;  
  145.  
  146. (deftrap _registercomponent ((cd :componentdescription) (componententrypoint :pointer) (global :signed-integer) (componentname :handle) (componentinfo :handle) (componenticon :handle))
  147.    (:stack (:pointer :componentrecord))
  148.    (:stack-trap #xA82A :d0 1 cd componententrypoint global componentname componentinfo componenticon))
  149.  
  150. (deftrap _registercomponentresource ((tr (:handle :componentresource)) (global :signed-integer))
  151.    (:stack (:pointer :componentrecord))
  152.    (:stack-trap #xA82A :d0 18 tr global))
  153.  
  154. (deftrap _unregistercomponent ((acomponent (:pointer :componentrecord)))
  155.    (:stack :signed-integer)
  156.    (:stack-trap #xA82A :d0 2 acomponent))
  157.  
  158.  
  159. (deftrap _findnextcomponent ((acomponent (:pointer :componentrecord)) (looking :componentdescription))
  160.    (:stack (:pointer :componentrecord))
  161.    (:stack-trap #xA82A :d0 4 acomponent looking))
  162.  
  163. (deftrap _countcomponents ((looking :componentdescription))
  164.    (:stack :signed-long)
  165.    (:stack-trap #xA82A :d0 3 looking))
  166.  
  167.  
  168. (deftrap _getcomponentinfo ((acomponent (:pointer :componentrecord)) (cd (:pointer :componentdescription)) (componentname :handle) (componentinfo :handle) (componenticon :handle))
  169.    (:stack :signed-integer)
  170.    (:stack-trap #xA82A :d0 5 acomponent cd componentname componentinfo componenticon))
  171.  
  172. (deftrap _getcomponentlistmodseed nil
  173.    (:stack :signed-long)
  174.    (:stack-trap #xA82A :d0 6))
  175.  
  176. ;  *******************************************************
  177. ; * Component Instance Allocation and dispatch routines 
  178. ; *******************************************************
  179. ;  
  180.  
  181. (deftrap _opencomponent ((acomponent (:pointer :componentrecord)))
  182.    (:stack (:pointer :componentinstancerecord))
  183.    (:stack-trap #xA82A :d0 7 acomponent))
  184.  
  185. (deftrap _closecomponent ((acomponentinstance (:pointer :componentinstancerecord)))
  186.    (:stack :signed-integer)
  187.    (:stack-trap #xA82A :d0 8 acomponentinstance))
  188.  
  189.  
  190. (deftrap _getcomponentinstanceerror ((acomponentinstance (:pointer :componentinstancerecord)))
  191.    (:stack :signed-integer)
  192.    (:stack-trap #xA82A :d0 10 acomponentinstance))
  193.  
  194. ;   direct calls to the Components  
  195.  
  196. (deftrap _componentfunctionimplemented ((ci (:pointer :componentinstancerecord)) (ftnnumber :signed-integer))
  197.    (:stack :signed-long)
  198.    (:stack-trap #xA82A :d0 0 ci ftnnumber ((+ (ash 2 16) 65533) :signed-longint)))
  199.  
  200. (deftrap _getcomponentversion ((ci (:pointer :componentinstancerecord)))
  201.    (:stack :signed-long)
  202.    (:stack-trap #xA82A :d0 0 ci ((+ (ash 0 16) 65532) :signed-longint)))
  203.  
  204. (deftrap _componentsettarget ((ci (:pointer :componentinstancerecord)) (target (:pointer :componentinstancerecord)))
  205.    (:stack :signed-long)
  206.    (:stack-trap #xA82A :d0 0 ci target ((+ (ash 4 16) 65530) :signed-longint)))
  207.  
  208. ; ****************************************************
  209. ; *                                                    *
  210. ; *               CALLS MADE BY Components             *
  211. ; *                                                    *
  212. ; ******************************************************
  213.  
  214. ;  *******************************************************
  215. ; * Component Management routines
  216. ; *******************************************************
  217. ;  
  218.  
  219. (deftrap _setcomponentinstanceerror ((acomponentinstance (:pointer :componentinstancerecord)) (theerror :signed-integer))
  220.    nil
  221.    (:stack-trap #xA82A :d0 11 acomponentinstance theerror))
  222.  
  223.  
  224. (deftrap _getcomponentrefcon ((acomponent (:pointer :componentrecord)))
  225.    (:stack :signed-long)
  226.    (:stack-trap #xA82A :d0 16 acomponent))
  227.  
  228. (deftrap _setcomponentrefcon ((acomponent (:pointer :componentrecord)) (therefcon :signed-long))
  229.    nil
  230.    (:stack-trap #xA82A :d0 17 acomponent therefcon))
  231.  
  232.  
  233. (deftrap _opencomponentresfile ((acomponent (:pointer :componentrecord)))
  234.    (:stack :signed-integer)
  235.    (:stack-trap #xA82A :d0 21 acomponent))
  236.  
  237. (deftrap _closecomponentresfile ((refnum :signed-integer))
  238.    (:stack :signed-integer)
  239.    (:stack-trap #xA82A :d0 24 refnum))
  240.  
  241. ;  *******************************************************
  242. ; * Component Instance Management routines
  243. ; *******************************************************
  244. ;  
  245.  
  246. (deftrap _getcomponentinstancestorage ((acomponentinstance (:pointer :componentinstancerecord)))
  247.    (:stack :handle)
  248.    (:stack-trap #xA82A :d0 12 acomponentinstance))
  249.  
  250. (deftrap _setcomponentinstancestorage ((acomponentinstance (:pointer :componentinstancerecord)) (thestorage :handle))
  251.    nil
  252.    (:stack-trap #xA82A :d0 13 acomponentinstance thestorage))
  253.  
  254.  
  255. (deftrap _getcomponentinstancea5 ((acomponentinstance (:pointer :componentinstancerecord)))
  256.    (:stack :signed-long)
  257.    (:stack-trap #xA82A :d0 14 acomponentinstance))
  258.  
  259. (deftrap _setcomponentinstancea5 ((acomponentinstance (:pointer :componentinstancerecord)) (thea5 :signed-long))
  260.    nil
  261.    (:stack-trap #xA82A :d0 15 acomponentinstance thea5))
  262.  
  263.  
  264. (deftrap _countcomponentinstances ((acomponent (:pointer :componentrecord)))
  265.    (:stack :signed-long)
  266.    (:stack-trap #xA82A :d0 19 acomponent))
  267.  
  268. ;   useful helper routines for convenient method dispatching  
  269.  
  270. (deftrap _callcomponentfunction ((params :componentparameters) (func :pointer))
  271.    (:stack :signed-long)
  272.    (:stack-trap #xA82A :d0 255 params func))
  273.  
  274. (deftrap _callcomponentfunctionwithstorage ((storage :handle) (params :componentparameters) (func :pointer))
  275.    (:stack :signed-long)
  276.    (:stack-trap #xA82A :d0 255 storage params func))
  277.  
  278. (deftrap _delegatecomponentcall ((originalparams :componentparameters) (ci (:pointer :componentinstancerecord)))
  279.    (:stack :signed-long)
  280.    (:stack-trap #xA82A :d0 36 originalparams ci))
  281.  
  282.  
  283. (deftrap _setdefaultcomponent ((acomponent (:pointer :componentrecord)) (flags :signed-integer))
  284.    (:stack :signed-integer)
  285.    (:stack-trap #xA82A :d0 30 acomponent flags))
  286.  
  287. (deftrap _opendefaultcomponent ((componenttype :ostype) (componentsubtype :ostype))
  288.    (:stack (:pointer :componentinstancerecord))
  289.    (:stack-trap #xA82A :d0 33 componenttype componentsubtype))
  290.  
  291. (deftrap _capturecomponent ((capturedcomponent (:pointer :componentrecord)) (capturingcomponent (:pointer :componentrecord)))
  292.    (:stack (:pointer :componentrecord))
  293.    (:stack-trap #xA82A :d0 28 capturedcomponent capturingcomponent))
  294.  
  295. (deftrap _uncapturecomponent ((acomponent (:pointer :componentrecord)))
  296.    (:stack :signed-integer)
  297.    (:stack-trap #xA82A :d0 29 acomponent))
  298.  
  299. (deftrap _registercomponentresourcefile ((resrefnum :signed-integer) (global :signed-integer))
  300.    (:stack :signed-long)
  301.    (:stack-trap #xA82A :d0 20 resrefnum global))
  302.  
  303. (deftrap _getcomponenticonsuite ((acomponent (:pointer :componentrecord)) (iconsuite (:pointer :handle)))
  304.    (:stack :signed-integer)
  305.    (:stack-trap #xA82A :d0 42 acomponent iconsuite))
  306.  
  307. ; $ENDC                         ;  UsingComponents 
  308.  
  309. ; $IFC NOT UsingIncludes
  310.  
  311. ; $ENDC
  312.  
  313.  
  314. (export '($BADCOMPONENTSELECTOR $BADCOMPONENTINSTANCE $COMPONENTDONTREGISTER
  315.           $COMPONENTNOTCAPTURED $VALIDINSTANCESEXIST $INVALIDCOMPONENTID
  316.           $DEFAULTCOMPONENTANYFLAGSANYMANUFACTURERANYSUBTYPE
  317.           $DEFAULTCOMPONENTANYFLAGSANYMANUFACTURER $DEFAULTCOMPONENTANYSUBTYPE
  318.           $DEFAULTCOMPONENTANYMANUFACTURER $DEFAULTCOMPONENTANYFLAGS
  319.           $DEFAULTCOMPONENTIDENTICAL $KCOMPONENTUNREGISTERSELECT
  320.           $KCOMPONENTTARGETSELECT $KCOMPONENTREGISTERSELECT
  321.           $KCOMPONENTVERSIONSELECT $KCOMPONENTCANDOSELECT
  322.           $KCOMPONENTCLOSESELECT $KCOMPONENTOPENSELECT
  323.           $COMPONENTAUTOVERSIONINCLUDEFLAGS $COMPONENTWANTSUNREGISTER
  324.           $COMPONENTDOAUTOVERSION $CMPWANTSREGISTERMESSAGE
  325.           $KANYCOMPONENTFLAGSMASK $KANYCOMPONENTMANUFACTURER
  326.           $KANYCOMPONENTSUBTYPE $KANYCOMPONENTTYPE $GESTALTCOMPONENTMGR))
  327. (provide-interface 'Components)